sdvaluestruct module

class sd.api.sdvaluestruct.SDValueStruct(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdvalue.SDValue

getClassName() → str

Returns the most specific name of the class this APIObject is

getPropertyValue(sdProperty: sd.api.sdproperty.SDProperty) → Optional[sd.api.sdvalue.SDValue]

Get the value of the specified struct property

Parameters

sdProperty – The property we want to retrieve the value from

getPropertyValueFromId(sdPropertyId: str) → Optional[sd.api.sdvalue.SDValue]

Get the value of the specified property given its string identifier

Parameters

sdPropertyId – The identifier of the property to get the value from

getType() → Optional[sd.api.sdtype.SDType]

Get the value type as string

release() → None

Releases an APIObject

static sNew(sdTypeStruct: sd.api.sdtypestruct.SDTypeStruct) → Optional[sd.api.sdvaluestruct.SDValueStruct]

Create a new SDValueStruct from a SDTypeStruct

Parameters

sdTypeStruct – The SDTypeStruct to use to instantiate the SDValueStruct

setPropertyValue(sdProperty: sd.api.sdproperty.SDProperty, sdValue: sd.api.sdvalue.SDValue) → None

Set the value of the specified struct property

Parameters

• sdProperty – The property to change

• sdValue – The value to set

setPropertyValueFromId(sdPropertyId: str, sdValue: sd.api.sdvalue.SDValue) → None

Set the value of the specified struct property from its identifier

Parameters

• sdPropertyId – The identifier of the property to set

• sdValue – The value to set